Skip to content

Add various cleanup to command/prompt files#738

Merged
chrisaddy merged 5 commits intomasterfrom
command-cleanup
Jan 30, 2026
Merged

Add various cleanup to command/prompt files#738
chrisaddy merged 5 commits intomasterfrom
command-cleanup

Conversation

@forstmeier
Copy link
Copy Markdown
Collaborator

@forstmeier forstmeier commented Jan 29, 2026

Overview

Changes

  • add various cleanups/tweaks to CLAUDE.md
  • add various cleanups/tweaks to maskfile.md
  • added initial Markdown linter/configuration/pre-commit check

Context

The only functional change was I updated the pull request Mask command for Ralph to have an optional parameter. Not sure if that really breaks things.

Summary by CodeRabbit

  • New Features

    • Enabled Markdown linting and added an automated pre-commit check for Markdown files.
  • Documentation

    • Reworded and reformatted docs and help text for clarity; standardized terminology from “PR” to “pull request.”
    • Added markdownlint suppression where needed.
  • Chores

    • Added the markdown lint tool to the environment and updated developer scripts, CLI messages, prompts, and labels for consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@forstmeier forstmeier self-assigned this Jan 29, 2026
@github-project-automation github-project-automation Bot moved this to To Do in Overview Jan 29, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 29, 2026

📝 Walkthrough

Walkthrough

Adds markdown linting and a local pre-commit markdown hook: markdownlint-cli added to the Flox environment, new .markdownlint.yaml, a local markdown pre-commit hook, and multiple text/formatting/script-reference updates across mask tooling and docs.

Changes

Cohort / File(s) Summary
Environment & lint config
.​flox/env/manifest.toml, .markdownlint.yaml
Added markdownlint-cli package path to the Flox env manifest; introduced Markdownlint config (line length 120, code_blocks/tables disabled, MD024 siblings_only, MD033 allowed_elements, MD041 disabled).
Pre-commit hook
.pre-commit-config.yaml
Added a local markdown hook (id: markdown) that runs mask development markdown all, pass_filenames: false, types: [file, markdown], language: system, fail_fast: true.
Mask tooling & scripts
maskfile.md
Replaced “PR” with “pull request” in messaging, renamed ralph-preflight.shralph_preflight.sh references, adjusted label color, cleaned executable display formatting, and other text/formatting refinements.
Documentation minor edits
CLAUDE.md, README.md
Line-wrapping and minor wording reflows; added markdownlint suppression comment in README and small formatting tweaks in CLAUDE.md.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer
  participant Git as Git
  participant Pre as pre-commit
  participant Mask as Mask (local hook)
  participant MDL as markdownlint-cli

  Dev->>Git: create commit
  Git->>Pre: trigger pre-commit hooks
  Pre->>Mask: invoke "mask development markdown all"
  Mask->>MDL: run markdownlint using `.markdownlint.yaml`
  MDL-->>Mask: return lint results
  Mask-->>Pre: exit code (0 or non-0)
  Pre-->>Git: allow or block commit
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Add various cleanup to command/prompt files' is vague and generic, using the term 'various cleanup' which doesn't convey specific information about the actual changes made. Consider a more specific title that reflects the primary changes, such as 'Add Markdown linting and update Ralph pull request terminology' to better communicate the main intent.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch command-cleanup

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds Markdown linting infrastructure and performs cleanup/consistency improvements across command and prompt files. The changes standardize terminology (PR → pull request), fix file naming (ralph-preflight → ralph_preflight), and improve formatting for readability.

Changes:

  • Added Markdown linting configuration, pre-commit hook, and Mask commands
  • Standardized terminology from "PR" to "pull request" throughout maskfile
  • Updated ralph-preflight.sh references to use underscore naming convention
  • Improved line formatting in CLAUDE.md and README.md for better readability

Reviewed changes

Copilot reviewed 6 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
maskfile.md Added Markdown linting commands, standardized terminology to "pull request", updated script references, changed ralph parameter from OPTIONS to positional
README.md Added markdownlint disable comment and reformatted long link line
CLAUDE.md Improved readability by breaking long lines and adding blank lines between sections
.pre-commit-config.yaml Added Markdown linting pre-commit hook
.markdownlint.yaml Created Markdown linting configuration file
.flox/env/manifest.toml Added markdownlint-cli dependency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread maskfile.md
Comment thread maskfile.md
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 29, 2026

Greptile Overview

Greptile Summary

This PR adds Markdown linting infrastructure and improves documentation formatting consistency. The changes include:

  • Added markdownlint-cli to the development environment with a sensible configuration that supports the project's custom <promise> tag
  • Created new mask development markdown commands for linting Markdown files
  • Added pre-commit hook to automatically check Markdown files
  • Standardized terminology from "PR" to "pull request" throughout documentation
  • Updated mask ralph pull-request command to use an optional positional parameter instead of the --pr flag (functional change)
  • Fixed various formatting issues to comply with the new linting rules
  • Renamed tools/ralph-preflight.sh to tools/ralph_preflight.sh for naming consistency

All changes are consistent with the project's documentation standards and the Ralph workflow guidelines in CLAUDE.md. The error message mentioned in previous threads has been correctly updated to reference the new command syntax.

Confidence Score: 5/5

  • Safe to merge - all changes are low-risk documentation and tooling improvements
  • The changes are well-structured, primarily focused on documentation formatting and linting infrastructure. The only functional change (making pull_request_number optional) is backward compatible since it falls back to auto-detection. All references to the renamed script and updated commands have been properly updated throughout the codebase.
  • No files require special attention

Important Files Changed

Filename Overview
.markdownlint.yaml Added markdownlint configuration with sensible defaults and promise tag support
.pre-commit-config.yaml Added markdown linting hook to pre-commit checks
CLAUDE.md Improved formatting, standardized terminology from PR to pull request, updated ralph command
maskfile.md Added markdown linting commands, fixed formatting, standardized terminology, updated ralph command to use optional parameter

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Comment thread maskfile.md
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In @.flox/env/manifest.toml:
- Line 44: Update the markdownlint-cli package path in the manifest so Nix picks
the Node package: change the value of the markdownlint-cli.pkg-path entry to
"nodePackages.markdownlint-cli" (preserve the string quotes) so the environment
activation resolves the Node package correctly.

In `@maskfile.md`:
- Around line 515-545: The markdownlint invocation in the "lint" task currently
passes "#.flox" "#.venv" "#target" as args which markdownlint-cli treats as file
globs instead of ignore patterns; update the command in the "lint" section (the
line containing markdownlint "**/*.md" "#.flox" "#.venv" "#target") to use the
proper ignore flags (e.g., --ignore or -i) for each of those paths so they are
excluded (replace each "#.flox", "#.venv", "#target" with corresponding --ignore
"<path>" entries).

Comment thread .flox/env/manifest.toml
Comment thread maskfile.md
@github-project-automation github-project-automation Bot moved this from To Do to In Progress in Overview Jan 29, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jan 29, 2026
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 29, 2026

Additional Comments (1)

CLAUDE.md
Documentation doesn't match the updated command signature in maskfile.md. The command now uses a positional parameter [pull_request_number] instead of --pr <number> flag.

- `mask ralph pr [pull_request_number]` - Process PR review feedback interactively
Prompt To Fix With AI
This is a comment left during a code review.
Path: CLAUDE.md
Line: 60:60

Comment:
Documentation doesn't match the updated command signature in `maskfile.md`. The command now uses a positional parameter `[pull_request_number]` instead of `--pr <number>` flag.

```suggestion
- `mask ralph pr [pull_request_number]` - Process PR review feedback interactively
```

How can I resolve this? If you propose a fix, please make it concise.

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jan 29, 2026
Copilot AI review requested due to automatic review settings January 29, 2026 03:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 9 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread maskfile.md
Comment thread maskfile.md
Comment thread maskfile.md Outdated
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@CLAUDE.md`:
- Line 1: The Markdown header "# claude" uses all-lowercase; update the header
text to use conventional capitalization (e.g., change "# claude" to "# Claude"
or another title-case variant) so the document follows standard Markdown title
conventions.
- Around line 32-33: Replace the non-breaking hyphen character in the string
"third‑party" with a standard ASCII hyphen so the text reads "third-party";
locate the occurrence in CLAUDE.md (the phrase "third‑party") and update that
single character to U+002D to ensure normal search, copy-paste, and tooling
behavior.

Comment thread CLAUDE.md
Comment thread CLAUDE.md Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jan 29, 2026
Copilot AI review requested due to automatic review settings January 29, 2026 03:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 9 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread maskfile.md
Comment thread CLAUDE.md
@chrisaddy chrisaddy merged commit 0161c62 into master Jan 30, 2026
4 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Overview Jan 30, 2026
@forstmeier forstmeier deleted the command-cleanup branch February 4, 2026 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants